Salesforce UX API

(0 reviews)

TMF-666 PATCH Update Account Aria

Update account in Aria

URL

https://[localhost]:[port]/sfdc-ux/v1/{businessId}/billingAccount/{id}

url Param

name	type	description	required
businessId	string	2 letter ISO 3166 country code (TT, BB, JM, PA, etc.) identifying the business unit.	Y
id	string	Unique identifier of the account	Y

name	value	description	required
client_id	string	The client_id identifying the channel.	Y
client_secret	string	Password associated with the client_id.	Y
X-Correlation-ID	string	An identifier for the current call chain that can be used to tie together log entries on multiple layers (e.g. client, server, mainframe). This identifier must be designed to be unique across all applications. Note - Mule default behavior creates a sample x-correlation-id field if value is not passed from client, API will use this value in case value is not passed in API request	Y*
channelId	string	Channel to business: Eg: "SFDC-B2C"	Y
lob	string	The Line of Business Identifier, Eg: POSTPAID	Y
targetSystem	String	This describes the end system, Eg: “Aria".	Y

Body

Request

{
    "taxExemption": [
        {
            "reason": "T",
            "@type": "TaxExemptCertificate",
            "certificateNumber": "89675674898767465637645666666879862923649997324634",
            "action": "add" //( allowed values are "add" or "replace")
        }
    ],
    "financialAccount": {
        "name": "41006529-40010719Dunning Group",
        "@type": "DunningGroupRef",
        "id": "41006529-40010719_DG"
    },
    "characteristic": [
        {
            "value": "Two april",
            "valueType": "string",
            "name": "firstName"
        },
        {
            "value": "Two april",
            "valueType": "string",
            "name": "lastName"
        },
        {
            "value": "Two april",
            "valueType": "string",
            "name": "companyName"
        },
        {
            "value": "Terms",
            "valueType": "string",
            "name": "paymentOption"
        },
        {
            "value": "Medium",
            "valueType": "string",
            "name": "riskProfileId"
        }
    ],
    "defaultPaymentMethod": {
        "name": "Net_23_Days",
        "@referredType": "NonAutoPay",
        "id": "PM-12345"
    },
    "relatedParty": [
        {
            "@type": "BillingGroupRef",
            "id": "41006529-40010719_BG"
        },
        {
            "characteristic": [
                {
                    "value": "SOHO",
                    "valueType": "string",
                    "name": "classification"
                }
            ],
            "role": "Owner",
            "@referredType": "Customer"
        }
    ],
    "contact": [
        {
            "contactMedium": [
                {
                    "@referredType": "statementContact",
                    "mediumType": "Phone",
                    "characteristic": {
                        "country": "US",
                        "stateOrProvince": "PR",
                        "postCode": "00926",
                        "city": "San Juan",
                        "street1": "1234 Calle 7",
                        "phoneNumber": "7788990087",
                        "emailAddress": "test@gmail.com",
                        "faxNumber": ""
                    }
                },
                {
                    "@referredType": "accountContact",
                    "mediumType": "Phone",
                    "characteristic": {
                        "country": "US",
                        "stateOrProvince": "PR",
                        "postCode": "00926",
                        "city": "San Juan",
                        "street1": "1234 Calle 7",
                        "phoneNumber": "7788990087",
                        "emailAddress": "test@gmail.com",
                        "faxNumber": ""
                    }
                }
            ]
        }
    ],
    "billStructure": {
        "presentationMedia": [
            {
                "@type": "notify_method",
                "name": "eMail"
            },
            {
                "@type": "BillDeliveryMethod",
                "name": "eMail"
            }
        ]
    }
}

Definitions

name	type	description	required
defaultPaymentMethod	object	Payment method details object	Y*
defaultPaymentMethod.name	string	Client-defined identifier of the collection group to assign to the specified billing group. Note - collection group value will be “AutoPay_Due_X_PR": "where X could be 0 to 18" as per Aria system	Y
defaultPaymentMethod.@referredType	string	Autopay/Non-Autopay	Y*
relatedParty	array	Related Entity reference. A related party defines party or party role linked to a specific entity	Y
relatedParty.id	string	Client-defined unique identifier for billing group	Y
relatedParty.@type	string	Type of the related party	Y
relatedParty.@referredType	string	The actual type of the target instance when needed for disambiguation. Note - This is mandatory for B2B 'SOHO/Small' customer	Y*
relatedParty.characteristic	array	characteristic array of related party	N
relatedParty.characteristic.name	string	characteristic name of related party	Y*
relatedParty.characteristic.valueType	string	characteristic value type of related party	N
relatedParty.characteristic.value	string	characteristic value of related party	Y*
financialAccount	object	A financial Account reference	Y
financialAccount.id	string	The client-defined identifier of the dunning group.	Y
financialAccount.@type	string	Type of account	Y
characteristic	array	A list of characteristics. Describes the characteristic of a billing account. Please refer below characteristic values table for more details.	Y*
characteristic.name	string	Name of the characteristic	Y*
characteristic.value	string	The value of the characteristic	Y*
accountType	string	A categorization of an account, such as individual, joint, and so forth, whose instances share some of the same characteristics. Note: for flexibility we use a String here but an implementation may use an enumeration with a limited list of valid values :B2B/B2C	Y*
taxExemption	array	Proof of freedom from taxes imposed by a taxing jurisdiction.	N
taxExemption.certificateNumber	string	the tax exemption certificate number	N
taxExemption.reason	string	Reason of the tax exemption	N
taxExemption.action	string	Account supplemental field directives, specifies what actions to be take ( replace or add the certificateNumber/reason/both)	N
taxExemption.@type	string	Tax exemption type	N

characteristic Values:

Characteristic name	type	description	required
paymentOption	string	This allows you to select either payment methods (such as a credit card or other electronic form of payment) or payment terms (such as a physical check) when creating or modifying a billing group'. Conditional mandatory - for the Methods (payment_option) it's mandatory	Y*
riskProfileId	string	lient-defined dunning process identifier. Eg: HIGH, MEDIUM, LOW	Y*
firstName1	string	Account Contact First Name	N
lastName1	string	Account Contact Last Name	N
companyName1	string	Account Contact Company Name	N
firstName2	string	Statement Contact First Name	N
lastName2	string	Statement Contact Last Name	N
companyName2	string	Statement Contact Company Name	N
language	string	Language	N
localeName	string	Local Name	N
functional_acct_group	string	functional account group	N
retroactive_start_date	string	Date, to set for retroactive start	N

relatedParty @typesValues:

relatedParty @type	type	description	required
BillingGroupRef	string	reference of group billing	N
CompanyCodeRef	string	reference code of company	N
MigratedAccountRef	string	account reference of migrated account. allowed value is 'BAN'	N

relatedParty @referredType	type	description	required
Customer	string	Customer Class Note - This is mandatory for B2B 'SOHO/Small' customer	Y*

Possible response success

This section defines all the possible data structures received by the client and that must be considered satisfactory at the time of responding to the method.

[ 200 ]

OK - PATCH request processed successfully, response body contains an entity corresponding to the requested resource.

Response

{
    "taxExemption": [
        {
            "reason": "T",
            "@type": "TaxExemptCertificate",
            "certificateNumber": "89675674898767465637645666666879862923649997324634",
            "action": "add"
        }
    ],
    "financialAccount": {
        "name": "41006529-40010719Dunning Group",
        "@type": "DunningGroupRef",
        "id": "41006529-40010719_DG"
    },
    "characteristic": [
        {
            "value": "Two april",
            "valueType": "string",
            "name": "firstName"
        },
        {
            "value": "Two april",
            "valueType": "string",
            "name": "lastName"
        },
        {
            "value": "Two april",
            "valueType": "string",
            "name": "companyName"
        },
        {
            "value": "Terms",
            "valueType": "string",
            "name": "paymentOption"
        },
        {
            "value": "Medium",
            "valueType": "string",
            "name": "riskProfileId"
        }
    ],
    "defaultPaymentMethod": {
        "name": "Net_23_Days",
        "@referredType": "NonAutoPay",
        "id": "PM-12345"
    },
    "contact": [
        {
            "contactMedium": [
                {
                    "@referredType": "statementContact",
                    "mediumType": "Phone",
                    "characteristic": {
                        "country": "US",
                        "stateOrProvince": "PR",
                        "postCode": "00926",
                        "city": "San Juan",
                        "street1": "1234 Calle 7",
                        "phoneNumber": "7788990087",
                        "emailAddress": "test@gmail.com",
                        "faxNumber": ""
                    }
                },
                {
                    "@referredType": "accountContact",
                    "mediumType": "Phone",
                    "characteristic": {
                        "country": "US",
                        "stateOrProvince": "PR",
                        "postCode": "00926",
                        "city": "San Juan",
                        "street1": "1234 Calle 7",
                        "phoneNumber": "7788990087",
                        "emailAddress": "test@gmail.com",
                        "faxNumber": ""
                    }
                }
            ]
        }
    ],
    "billStructure": {
        "presentationMedia": [
            {
                "@type": "notify_method",
                "name": "eMail"
            },
            {
                "@type": "BillDeliveryMethod",
                "name": "eMail"
            }
        ]
    },
    "accountRelationship": [
        {
            "account": {
                "id": "27496407",
                "@type": "billing_group_no",
                "@referredType": "BillingAriaAccount"
            }
        },
        {
            "account": {
                "id": "60145375",
                "@type": "stmt_contact_no",
                "@referredType": "BillingAriaAccount"
            }
        },
        {
            "account": {
                "id": "60145399",
                "@type": "bill_contact_no",
                "@referredType": "BillingAriaAccount"
            }
        },
        {
            "account": {
                "id": "41000423-40000542",
                "@type": "chief_client_acct_id",
                "@referredType": "BillingAriaAccount"
            }
        },
        {
            "account": {
                "id": "4559034",
                "@type": "chief_acct_no",
                "@referredType": "BillingAriaAccount"
            }
        }
    ]
}

Definitions

name	type	description	required
accountRelationship	array	account array	N
accountRelationship.account	object	account object	N
accountRelationship.account.@referredType	String	Referred type	N
accountRelationship.account.@type	String	Aria field name	N
accountRelationship.account.id	String	billing group number	N
		appended the json request paylaod	N

Possible response error

In this section all the possible data structures received by the client are defined and that must be considered as unsatisfactory when responding to the method.

[ 400 ]

Bad Request - the request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modifications.

{
  "errors" : [{
      "code" : 400,
      "message" : "The request is invalid or not properly formed.",
      "description" : "Malformed request syntax, invalid request message framing, or deceptive request routing."
    }]
}

[ 401 ]

Unauthorized - The request has not been applied because it lacks valid authentication credentials for the target resource.

{
  "errors" : [{
      "code" : 401,
      "message" : "The user could not be authenticated for this request.",
      "description" : "The request has not been applied because it lacks valid authentication credentials for the target resource."
    }]
}

[ 403 ]

Forbidden - Indicates that the server understood the request but refuses to fulfill it. If authentication credentials were provided in the request, the server considers them insufficient to grant access. The client SHOULD NOT automatically repeat the request with the same credentials. The client MAY repeat the request with new or different credentials.

[ 404 ]

Not Found - server has not found a resource with that URI. This may be temporary and permanent condition. This status code is commonly used when the server does not wish to reveal exactly why the request has been refused, or when no other response is applicable.

{
  "errors" : [{
      "code" : 404,
      "message" : "The server could not find the requested resource.",
      "description" : "The requested operation failed because a resource associated with the request could not be found."
    }]
}

[ 405 ]

Method Not Allowed - HTTP method not allowed for this resource. The method specified in the Request-Line is not allowed for the resource identified by the Request-URI.

{
    "errors": [{
            "code": 405,
             "message": "APIKIT:METHOD_NOT_ALLOWED",
             "description": "HTTP Method get not allowed for : /shippingInfo",
        }]
}

[ 500 ]

Internal Server Error - server encountered an error processing request. This should not happen normally, but it is a generic error message, given when no more specific message is suitable.

{
  "errors" : [{
      "code" : 500,
      "message" : "Internal Error",
      "description": "The request failed due to an internal error"
    }]
}

[ 501 ]

Not implemented - indicates that the server does not support the functionality required to fulfill the request. This is the appropriate response when the server does not recognize the request method and is not capable of supporting it for any resource.

{
  "errors" : [{
      "code" : 501,
      "message" : "Not implemented",
      "description" : "Operation POST /shippingInfo for Business Id: xxxx not implemented",

    }]
  }

[ 502]

Bad Gateway - gateway is available but backend service is not. The server, while acting as a gateway or proxy, received an invalid response from the upstream server it accessed in attempting to fulfill the request.

[ 503 ]

Service Unavailable - temporary maintenance of service, try again later. The implication is that this is a temporary condition which will be alleviated after some delay. If known, the length of the delay will be indicated in a Retry-After header. If no Retry-After is given, the client SHOULD handle the response as it would for a 500 response. Note: The existence of the 503 status code does not imply that a server will use it when becoming overloaded. Servers may simply refuse the connection.

    Retry-After: 120

Reviews

TMF-666 PATCH Update Account Aria

URL

url Param

Header

Body

Request

Definitions

characteristic Values:

relatedParty @typesValues:

Possible response success

[ 200 ]

Response

Definitions

Possible response error

[ 400 ]

[ 401 ]

[ 403 ]

[ 404 ]

[ 405 ]

[ 500 ]

[ 501 ]

[ 502]

[ 503 ]

Reviews